MarkLogic 12 Product Documentation
POST /manage/v2/databases/{id|name}/domains

Summary

This resource address creates a new domain for the specified Triggers database. For an example, see Installing and Configuring CPF in the Scripting Administrative Tasks Guide.

URL Parameters
format	The format of the posted data. Can be either `html`, `json`, or `xml` (default). This value overrides the Accept header if both are present.

Request Headers
Accept	The expected MIME type of the request body. If the `format?` parameter is present, it takes precedence over the Accept header.
Content-type	The MIME type of the data in the request body. Depending upon the value of the `format` parameter or Accept header, one of `application/xml`, `application/json`, or `text/html`.

Response Headers
Content-type	The MIME type of the data in the response body. Depending upon the value of the `format` parameter or Accept header, one of `application/xml`, `application/json`, or `text/html`.
Location	If the request causes a restart, a Location header is included in the reponse. The header contains a path with which to construct a URL to usable to test when the restart has completed.

Response

Upon success, MarkLogic Server returns status code 201 (Created). If the domain already exists or if the payload is malformed, a status code of 400 (Bad Request) is returned. A status code of 401 (Unauthorized) is returned if the user does not have the necessary privileges.

Required Privileges

This operation requires the manage-admin role, or the following privilege:

http://marklogic.com/xdmp/privileges/manage-admin

Usage Notes

The structure of the data in the request body is as follows. The domain-name property is required and accepts a string value. The scope property can be set to collection, directory, or document. The uri property is /, by default. The depth property is required when scope is set to directory. The eval-modules property is Modules, by default. The eval-root property is /, by default.

Note: The properties described here are for XML payloads. In general they are the same for JSON, with the exception that, in JSON, pipelines and permissions are expressed in singular form. For example, in JSON, permissions is instead permission and the format is: "permission":[{"role-name":"name", "capability":"cap"}].

domain-name

description

scope

uri

depth

eval-module

eval-root

pipelines

This is a complex structure with the following children:

pipeline

permissions

The default set of permissions used in document creation.

This is a complex structure with the following children:

permission

Permission representation.

This is a complex structure with the following children:

role-name: The Role name (unique)
capability: The action/task permitted by a permission

Example


cat domain.json
==> 
   {
     "domain-name": "myDomain",
     "description": "mydesc",
     "scope": "directory",
     "uri": "/",
     "depth": "infinity",
     "eval-module": "Modules",
     "eval-root": "/"
   }

curl -X POST --anyauth --user admin:admin \
--header "Content-Type:application/json" \
-d@domain.json http://localhost:8002/manage/v2/databases/Triggers/domains?format=json

==> Creates a new domain, named "myDomain," in the Triggers database.

MarkLogic 12 Product DocumentationPOST /manage/v2/databases/{id|name}/domains

Summary

Response

Required Privileges

Usage Notes

Example

MarkLogic 12 Product Documentation
POST /manage/v2/databases/{id|name}/domains